@jsenv/snapshot 2.6.11 → 2.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/snapshot",
-  "version": "2.6.11",
+  "version": "2.7.0",
   "description": "Snapshot testing",
   "license": "MIT",
   "author": {

package/src/replace_fluctuating_values.js

@@ -21,7 +21,7 @@ export const replaceFluctuatingValues = (
     stringType,
     rootDirectoryUrl,
     fileUrl,
-    removeAnsi = true,
+    preserveAnsi,
     // for unit test
     replaceFilesystemWellKnownValues = createReplaceFilesystemWellKnownValues({
       rootDirectoryUrl,
@@ -51,7 +51,7 @@ export const replaceFluctuatingValues = (
     if (stringType === "filesystem") {
       return replaceFilesystemWellKnownValues(value);
     }
-    if (removeAnsi) {
+    if (!preserveAnsi) {
       value = stripAnsi(value);
     }
     value = replaceFilesystemWellKnownValues(value, {

package/src/side_effects/filesystem/spy_filesystem_calls.js

@@ -37,6 +37,10 @@ export const spyFilesystemCalls = (
   const fileDescriptorPathMap = new Map();
   const fileRestoreMap = new Map();
   const onWriteFileDone = (fileUrl, stateBefore, stateAfter) => {
+    if (!stateAfter.found) {
+      // not suppoed to happen but could apparently
+      return;
+    }
     // we use same type because we don't want to differentiate between
     // - writing file for the 1st time
     // - updating file content

package/src/side_effects/render_side_effects.js

@@ -246,6 +246,7 @@ const renderText = (
           typeof value.stack === "string")
       ) {
         onRenderError();
+        // return renderMarkdownBlock(text.value.stack);
         const exception = createException(text.value, { rootDirectoryUrl });
         const exceptionText = errorStackHidden
           ? `${exception.name}: ${exception.message}`
@@ -306,24 +307,36 @@ const renderPotentialAnsi = (
   string,
   { stringType, sideEffect, sideEffectFileUrl, generateOutFileUrl, replace },
 ) => {
+  const rawTextBlock = renderMarkdownBlock(
+    replace(string, { stringType }),
+    "console",
+  );
   // for assert we want ideally hummm
   // colored in details block?
   const includesAnsi = ansiRegex().test(string);
   if (!includesAnsi) {
-    return renderMarkdownBlock(replace(string, { stringType }), "console");
+    return rawTextBlock;
   }
   const svgFilename = `${sideEffect.code}${sideEffect.counter ? `_${sideEffect.counter}` : ""}.svg`;
   const svgFileUrl = generateOutFileUrl(svgFilename);
-  let svgFileContent = renderTerminalSvg(string, {
-    head: false,
-    paddingTop: 10,
-    paddingBottom: 10,
-  });
+  let svgFileContent = renderTerminalSvg(
+    replace(string, { stringType: "console", preserveAnsi: true }),
+    {
+      head: false,
+      paddingTop: 10,
+      paddingBottom: 10,
+    },
+  );
   svgFileContent = replace(svgFileContent, { fileUrl: svgFileUrl });
   writeFileSync(svgFileUrl, svgFileContent);
   const svgFileRelativeUrl = urlToRelativeUrl(svgFileUrl, sideEffectFileUrl);
-  return `![img](${svgFileRelativeUrl})`;
-  // we will write a svg file
+  let md = `![img](${svgFileRelativeUrl})`;
+  md += "\n\n";
+  md += renderMarkdownDetails(`${rawTextBlock}`, {
+    summary: "see without style",
+  });
+  md += "\n";
+  return md;
 };
 
 export const renderFileContent = (text, { sideEffect, replace }) => {

package/src/side_effects/snapshot_tests.js

@@ -22,9 +22,9 @@ export const snapshotTests = async (
   {
     testName = urlToBasename(testFileUrl, true),
     sideEffectFileUrl,
-    sideEffectFilePattern = "./output/[test_name]/[test_name].md",
+    sideEffectFilePattern = "./output/[test_name].md",
     outDirectoryPattern = "./output/[test_name]/",
-    outFilePattern = "./output/[test_name]/[test_scenario]_[filename]",
+    outFilePattern = "./output/[test_scenario]/[filename]",
     rootDirectoryUrl,
     generatedBy = true,
     linkToSource = true,